.. _Menu:

==========================
Menu
==========================

.. toctree::
   :maxdepth: 2
   :hidden:
   :glob:
   
   EEex*
   

+-------------------------------------------------------------------+----------------------------------------------------+
| **Function**                                                      | **Description**                                    |
+-------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_AddPostResetListener<EEex_AddPostResetListener>`       | Add function to be called after F5 UI reload       |
+-------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_AddResetListener<EEex_AddResetListener>`               | Add function to the EEex_ResetListeners list       |
+-------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_AddUIMenuLoadListener<EEex_AddUIMenuLoadListener>`     | Add function to be called after initial UI.MENU    |
+-------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_DestroyInjectedTemplate<EEex_DestroyInjectedTemplate>` | Destroys an instance injected into a menu          |
+-------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_FetchMenuRes<EEex_FetchMenuRes>`                       | Fetch menu resource reference                      |
+-------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetListScroll<EEex_GetListScroll>`                     | Get list scroll position                           |
+-------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetMenuAddressFromItem<EEex_GetMenuAddressFromItem>`   | Return menu address from a menu item               |
+-------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetMenuFunctionOffset<EEex_GetMenuFunctionOffset>`     | Returns an array of menu offsets                   |
+-------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetMenuItemAddress<EEex_GetMenuItemAddress>`           | Return an address of an menu item                  |
+-------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetMenuStructure<EEex_GetMenuStructure>`               | Returns menu structure                             |
+-------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetMenuVariantFunction<EEex_GetMenuVariantFunction>`   | Returns lua function associated with menu's attrib |
+-------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetTrueMousePos<EEex_GetTrueMousePos>`                 | Returns x and y coordinate for mouse position      |
+-------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_InjectTemplate<EEex_InjectTemplate>`                   | Inject template into menu                          |
+-------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_IsCursorWithin<EEex_IsCursorWithin>`                   | Determines if mouse position is within a rectangle |
+-------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_IsCursorWithinMenu<EEex_IsCursorWithinMenu>`           | Determines if mouse position is within a menu item |
+-------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_LoadMenuFile<EEex_LoadMenuFile>`                       | Loads in the given .MENU file as if it were UI.MENU|
+-------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_ScreenToWorldXY<EEex_ScreenToWorldXY>`                 | Translates screenX, screenY into worldX, worldY    |
+-------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_SetListScroll<EEex_SetListScroll>`                     | Set list scroll position                           |
+-------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_SetMenuVariantFunction<EEex_SetMenuVariantFunction>`   | Overwrite lua function for with menu's attribute   |
+-------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_StoreTemplateInstance<EEex_StoreTemplateInstance>`     | Store a value into a menu template instance        |
+-------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_TranslateGameXY<EEex_TranslateGameXY>`                 | Translates mouseGameX, mouseGameY to viewX, viewY  |
+-------------------------------------------------------------------+----------------------------------------------------+